Skip to content

refactor: shared command descriptions and --cwd default #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Dec 11, 2024
Merged

refactor: shared command descriptions and --cwd default #592

merged 5 commits into from
Dec 11, 2024

Conversation

@BobbieGoede
Copy link
Member

@BobbieGoede BobbieGoede commented Dec 8, 2024 •
edited
Loading

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Is this a refactor and/or docs change 🤷

I found the ROOTDIR and cwd default value or fallback value a bit confusing, these changes should be functionally the same but instead handles the fallback to the shared argument configuration. Please make sure to check I'm not misunderstanding the fallback logic 😬

I'm slowly working on syncing the descriptions between the command usage -h output and those described on docs/api/commands pages, more PRs to come.

@BobbieGoede BobbieGoede self-assigned this Dec 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Dec 8, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 1.13636% with 87 lines in your changes missing coverage. Please review.

Please upload report for BASE (main@588a76a). Learn more about missing BASE report.

Files with missing lines Patch % Lines
src/commands/_shared.ts 4.76% 20 Missing ⚠️
src/commands/module/add.ts 0.00% 5 Missing ⚠️
src/commands/add.ts 0.00% 4 Missing ⚠️
src/commands/analyze.ts 0.00% 4 Missing ⚠️
src/commands/build-module.ts 0.00% 4 Missing ⚠️
src/commands/build.ts 0.00% 4 Missing ⚠️
src/commands/dev-child.ts 0.00% 4 Missing ⚠️
src/commands/dev.ts 0.00% 4 Missing ⚠️
src/commands/prepare.ts 0.00% 4 Missing ⚠️
src/commands/preview.ts 0.00% 4 Missing ⚠️
... and 9 more
Additional details and impacted files 
@@          Coverage Diff           @@
##             main    #592   +/-   ##
======================================
  Coverage        ?   1.31%           
======================================
  Files           ?      44           
  Lines           ?    2882           
  Branches        ?      44           
======================================
  Hits            ?      38           
  Misses          ?    2803           
  Partials        ?      41

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@BobbieGoede BobbieGoede mentioned this pull request Dec 8, 2024
Merged
@BobbieGoede
Copy link
Member Author

I split up sharedArgs into cwdArgs and logLevelArgs, as not all commands actually used the --log-level, this removes some noise from the docs as well in nuxt/nuxt#30199

danielroe
danielroe reviewed Dec 9, 2024
View reviewed changes
@danielroe danielroe merged commit 0245c91 into nuxt:main Dec 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pi0 pi0 pi0 left review comments

@danielroe danielroe danielroe approved these changes

Assignees

@BobbieGoede BobbieGoede

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@BobbieGoede @codecov-commenter @pi0 @danielroe